home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / telecomm / 576 / document / rufus_en.txt < prev    next >
Text File  |  1992-05-22  |  57KB  |  1,653 lines
  1.     RRRRRR     UU     UU    FFFFFFFFF  UU     UU    SSSSSSSS
  2.     RR   RR    UU     UU    FF         UU     UU   SS
  3.     RR    RR   UU     UU    FF         UU     UU   SS
  4.     RR   RR    UU     UU    FF         UU     UU    SSSS
  5.     RRRRRR     UU     UU    FFFFFFF    UU     UU       SSSS
  6.     RR  RR     UU     UU    FF         UU     UU          SS
  7.     RR   RR    UU     UU    FF         UU     UU          SS
  8.     RR    RR    UUUUUUU     FF          UUUUUUU    SSSSSSSS
  9.  
  10.  
  11. Version 1.02  [v. 1.06 notes added]
  12.  
  13. Universal Communication Software
  14.  
  15. Copyright © 1990 by Michael Bernards
  16. [English Translation © 1992 by \/apourware PLC, for Michael Bernards]
  17.  
  18. [Note:  While all care was taken to insure proper translation of the text,
  19. \/apourware, its employees and representatives cannot be held responsible
  20.  for any errors in this translation, or the original document used.  All
  21.  possible efforts will be made to correct any errors which \/apourware is
  22.  notified of.  Notification will be posted of the errors, and corrections,
  23.  at the original point(s) this document is made available.
  24.  This document is provided to allow your use and enjoyment of RUFUS. We
  25.  make no warranty of any type reguarding the suitability of RUFUS for the
  26.  activities you desire to attempt to use it to perform.  We cannot be held
  27.  liable for any losses you incur in your use of RUFUS.
  28.  In other words, use at your own risk!!
  29.  
  30.                M_Kg.
  31.      Mark Kelling -- \/apourware PLC
  32.      21 Mar. 1992      version  1.6C
  33. ]
  34.  
  35.  
  36.  
  37. - i -
  38.  
  39. Table of Contents
  40. Chapter 1
  41. Introduction                                       1
  42. 1.1       What does RUFUS do?                      1
  43. 1.2       A Few Words about the Shareware Concept  2
  44. 1.3       Computer Configuration                   2
  45. 1.4       The Manual                               2
  46. 1.5       Packing List                             3
  47. 1.6       Installation                             3
  48. 1.6.1     GDOS - "Was ist das?"                    4
  49.  
  50. Chapter 2
  51. An Overview                                        5
  52. 2.1       Menus                                    5
  53. 2.2       Dialogs                                  5
  54. 2.3       Window                                   5
  55.  
  56. Chapter 3
  57. The Menus                                          6
  58. 3.1       The 'Files' Menu                         6
  59. 3.1.1     INF load...                              6
  60. 3.1.2     INF write...                             6
  61. 3.1.3     EXecute Program...                       6
  62. 3.1.4     Shell Access                             6
  63. 3.1.5     Batch Start...                           6
  64. 3.1.6     Do Batch Command                         7
  65. 3.1.7     Quit                                     7
  66. 3.2       The 'Block' Menu                         7
  67. 3.2.1     Block Save...                            7
  68. 3.2.2     Block Send                               7
  69. 3.2.3     Copy Block to Clipboard                  7
  70. 3.3       The 'Transfer' Menu                      7
  71. 3.3.1     File Send...                             7
  72. 3.3.2     File Receive...                          7
  73. 3.3.3     ASCII File Send                          8
  74. 3.3.4     Buffer load...                           8
  75. 3.3.5     Buffer Save                              8
  76. 3.4       The 'Parameter' Menu                     8
  77. 3.4.1     RS232                                    8
  78. 3.4.2     Terminal                                 8
  79. 3.4.3     Protocal                                 9
  80. 3.4.4     Modem                                   10
  81. 3.4.5     F Keys                                  10
  82. 3.4.6     Numbers                                 10
  83. 3.4.7     Buffer                                  11
  84. 3.4.8     Set Fontz                               11
  85. 3.4.9     Paths                                   12
  86. 3.5       The "POP-UP" Menu                       12
  87.  
  88. Chapter 4
  89. Terminal Emulation                                13
  90. 4.1       VT52  Emulation                         13
  91. 4.2       VT100 Emulation                         13
  92. 4.2.1     ANSI Extensions                         13
  93. 4.2.2     VT200 Extensions                        13
  94.  
  95.  
  96.  
  97. - ii -
  98.  
  99. Chapter 5
  100. The Keyboard                                      14
  101. 5.1       General Keys                            14
  102. 5.2       Special Terminal Keys                   14
  103. 5.2.1     Keypad in VT52 Mode                     14
  104. 5.2.2     Keypad in VT100 Mode                    14
  105.  
  106. Chapter 6
  107. File Transfer                                     15
  108. 6.1       ASCII                                   15
  109. 6.2       XMODEM                                  15
  110. 6.3       YMODEM                                  15
  111. 6.3.1     YMODEM-G                                15
  112. 6.4       ZMODEM                                  15
  113. 6.5       STREAM                                  15
  114.  
  115. Chapter 7
  116. Modem Usage                                       16
  117. 7.1       The Proper Parameter                    16
  118. 7.2       Editing the Numbers                     16
  119. 7.3       Dialing a Number                        16
  120. 7.4       Dialing Several Numbers                 17
  121.  
  122. Chapter 8
  123. The Programming Language                          18
  124. 8.1       Overview                                18
  125. 8.2       Variables                               18
  126. 8.3       Labels and Branching                    18
  127. 8.4       The Commands                         18-23
  128.  
  129. Appendix A
  130. Emulation Implementation                       24-27
  131.  
  132. Appendix B
  133. Keyboard Combinations                             28
  134.  
  135. Appendix C
  136. Special Files                                     29
  137.  
  138. Appendix D
  139. Listing of RUFUS Commands                         30
  140.  
  141. Appendix E
  142. Escape Sequences in Terminal Emulations           31
  143.  
  144. Index                                             32
  145.  
  146.  
  147.  
  148.  
  149. - 1 -
  150.  
  151. Chapter 1
  152. Introduction
  153.  
  154.  
  155. 1.1       What does RUFUS do?
  156.  
  157. Terminal programs give access for the Atari ST to other computers.  From
  158. the beginning there exited many products with support for VT52 and VT100
  159. emulation.  As file transfer protocalls capabilities, almost all supplied
  160. XMODEM and KERMIT.
  161.  
  162. Meanwhile, that left the user with a long list of communication software
  163. capabilities to wish for.  The interface had itself certainly hardly been
  164. employed.  Of course, almost all programs had a GEM element assigned, but
  165. a true binding with the interface still scares many away on the ATARI.
  166. The consequence is -- a boring terminal representation.
  167.  
  168. [TR note: this section of text appeared damaged. This paragraph was
  169.  reconstructed best as could be.]
  170. Having a many color screen and a graphic containing HYPERSCREEN your
  171. modem's output can be well represented again with the picture screen
  172. representation commanding 640x400 points.  The future machines such
  173. as the TT are not completely supported, not having one at hand.
  174.  
  175. The basic idea of RUFUS was, a terminal program able to handle all
  176. screen types accessable from your house.
  177.  
  178. So RUFUS comes with a VT52 and a VT100 emulation.  The VT100 emulation
  179. also understands all ANSI codes and most VT2xx commands.  For transfer 
  180. protocalls RUFUS also offers in addition to X-, Y- and ZMODEM a special
  181. transfer mode for between two computers.  A complex modem management
  182. support works with online systems.  A special bonus is the accessory mode.
  183. RUFUS works also as an accessory and waits then with a new function,
  184. background transfer.
  185.  
  186. The formation of the dialog boxes and the menu lists come from a mutually
  187. consistant system and different respected programs.  So it is that in all
  188. boxes an OK and a CANCEL button are found, below on the right in the
  189. corner.  Through these clear command conventions the functions of RUFUS
  190. are easily learned.
  191.  
  192.  
  193.  
  194.  
  195. - 2 -
  196.  
  197. 1.2       A Few Words About the Shareware Principle
  198.  
  199. RUFUS is a product of the Shareware market.  This means the program may
  200. be freely copied and distributed.  No one must therefore purchase the
  201. proverbial cat in the bag.  Consequently, opposite from public domain 
  202. software, all rights remain with the author, and RUFUS cannot be sent or
  203. distributed through PD services.  Regular use requires the payment of a
  204. relatively small fee of DM40.00 to the author (address and Bank Transfer
  205. information below).  As a small show of many thanks for the recognition,
  206. register and receive upcomming updates information.  Also, a future goal
  207. is the payment of an additional DM10.00 fee getting the manual sent to you
  208. in printed form.  I hope for much, and that in the future being much more
  209. comfortable with the concept, to keep up continued expansion and 
  210. development through RUFUS royalties.
  211. Send error reports please to the following address:
  212.  
  213. Michael Bernards
  214. Bussardweg 1
  215. 5204 Lohmar/Geber
  216. West Germany
  217.  
  218. or by network:
  219. Michael Bernards@BN im Mausnet
  220. Michael_Bernards@SPACER im Zerberus-Netz
  221. MEGAMAIL:M_BERNARDS im MagicNet
  222. Fido-Net 2:244/11.4224
  223. MICHAEL_BERNARDS;MM im PCNet
  224. Bank Transfer Information:
  225. Raiffeisenbank Lohmar, BLZ 37069477, account 15490
  226.  
  227.  
  228. 1.3       Computer Configuration
  229.  
  230. To work, RUFUS needs an ATARI ST with at least 512 KB memory and a floppy
  231. disk drive.  Other graphics cards can be used, as long as a VDI driver is
  232. provided.
  233.  
  234.  
  235. 1.4       The Manual
  236.  
  237. The handbook is subdivided into four sections.  In the first part is an
  238. introduction to RUFUS, also a basic description of the parts.  Following
  239. is a detailed command description of all menus and dialog boxes and their
  240. function.  Next is a detail of the complex functions which RUFUS engages.
  241. In the Appendicies the user can find references to the important questions
  242. in overview.
  243.  
  244.  
  245.  
  246.  
  247. - 3 -
  248.  
  249. 1.5       Packing List
  250.  
  251. The following files belong with RUFUS:
  252.  
  253. AUTO
  254.   AMCLIGHT.PRG   AMCGDOS v4.00 by Arndt Beissner. Special version.
  255. GEMSYS
  256.   RUFUS05.FNT   Character set 7x5 Pixel
  257.   RUFUS09.FNT   Character set 11x6 Pixel with all ANSI Characters
  258.   RUFUS10.FNT   Character set 14x7 Pixel with all ANSI Characters
  259.   RUFUS12.FNT   Character set 16x8 Pixel with all ANSI Characters
  260.   GEMINI.FNT    Character set 10x6 Pixel
  261. RUFUSCOL
  262.   RUFUS.FNT     Font for use with color medium resolution monitor.
  263.   RUFUSCOL.TXT  Description of how to use the font.
  264. RUF
  265.         assorted example batch programs
  266. MODUL
  267.   TERM.TTP      BTX-Decoder
  268.   KERMIT.TTP    Kermit Transfer program
  269.   SZ.PRG        ZMODEM Send program
  270.   RZ.PRG        ZMODEM Receive program
  271. RUFUS.APP       the Program
  272. RUFUS.RSC       the Resource
  273. RUFUS.INF       Parameter file
  274. RUFUS.FNT       Character set used when GDOS is not resident (mono monitor)
  275. RUFUS.TXT       Manual to RUFUS in ASCII Format
  276. READ_ME.1ST     Hints and Update info
  277.  
  278. All registered customers who desire can receive the manual in printed
  279. form.
  280.  
  281.  
  282. 1.6       Installation
  283.  
  284. The installation of RUFUS is very simple.  The user needs only to copy
  285. the files into the folders [as listed in 1.5].  If the user does not have
  286. GDOS installed and wishes to use all the fonts possible with RUFUS, he
  287. should first study the next section [1.7] closely.
  288.  
  289. After you have RUFUS copied onto the correct disk, start the RUFUS.PRG.
  290. The menu and the window should appear on the screen.  Now select the
  291. PARAMETER menu and enter all personal parameters.  The many options
  292. should correct any problems.  If the user feels trapped with questions
  293. the following sections of the manual will answer them.
  294.  
  295. Should the user want to use RUFUS as an accessory, proceed as follows.
  296. RUFUS.PRG must be renamed RUFUS.ACC and copied into the root directory
  297. of the boot disk (C: for hard drives, A: for floppy).  The user must also
  298. copy RUFUS.RSC and (when present) RUFUS.INF to the root.
  299.  
  300.  
  301.  
  302.  
  303. - 4 -
  304.  
  305. 1.6.1     GDOS - "Was ist das?"
  306.  
  307. This is a question which, unfortunately, is heard too often still as
  308. more exotic programs become finished.  During development, the operating
  309. system interface is loved, only later is it found that one important part
  310. of GEM was dropped under the table.  Later this part was offered as a 
  311. free standing program.  Without this part GEM cannot load fonts or talk
  312. to some peripherals.
  313.  
  314. RUFUS relys only on system fonts and the one custom font; however, to
  315. place more than 80x25 in one window or screen, RUFUS also needs GDOS.
  316. It gives a backdoor for the user to not require the computer to have GDOS
  317. resident, but this is not recommended.  How else can it be said:  GDOS
  318. is a part of the operating system.  [To run RUFUS as an ACCessory, you
  319. _must_ have GDOS installed.  Otherwise, the computer will bomb.]
  320.  
  321. To install GDOS the user must follow these instructions:
  322. 1. A GDOS program must be copied into the AUTO folder on the boot disk.
  323. There are several suitable programs.  With RUFUS, the AMCGDOS program by
  324. Arnd Beissner is supplied.
  325. 2. The folder GEMSYS must also be copied to the root directory of the
  326. same boot disk.
  327. 3. Into the root directory of the boot disk the file named ASSIGN.SYS
  328. must be copied.
  329. 4. The computer is rebooted.  A message should appear saying GDOS is now
  330. installed.
  331.  
  332.  
  333.  
  334.  
  335.  
  336. - 5 -
  337.  
  338. Chapter 2
  339. The Interface
  340.  
  341.  
  342. 2.1       The Menu
  343.  
  344. Using the Menu the user can reach all the important RUFUS functions.
  345. When the user clicks with the mouse pointer in the menu bar a list falls.
  346. With these lists the desired function can be selected.
  347.  
  348.  
  349. 2.2       Dialoges
  350.  
  351. The dialoges in RUFUS appear to be somewhat different than those in other
  352. GEM programs.  They are based on the "Fliegenden Dialogen" from Julian
  353. Reschke, in RUFUS they do a good job.
  354.  
  355. All dialogs have a similar construction.  Above left in the corner is an
  356. underlined text, this is the function of the box.  On the oposite corner
  357. are the action buttons.  With these buttons the user exits the dialog.
  358. The heavily outlined button can also be selected with the RETURN key.  In
  359. the upper right corner is the folded button.  Clicking and holding with
  360. the mouse pointer there, the user can drag the dialog box and position it
  361. freely on the screen.
  362.  
  363. One additional command is the so called shortcut.  Everywhere there is a
  364. letter underlined, the user can select that function by pressing the key
  365. in combination with the ALTERNATE key.  So the user can exit almost every
  366. dialog with ALTERNATE-C for Cancel.
  367.  
  368. Dialed items selected by arrows (such as BAUDRATE in the RS232 menu) can
  369. be selected with the corresponding cursor keys.
  370.  
  371.  
  372. 2.3       The Window
  373.  
  374. In the same Window the terminal and the view buffer are accessable.  As is
  375. normal, the window has only one drag bar and one info line.  With the
  376. drag bar the window can be freely positioned on the screen.  In the title
  377. is the name of the last online service reached.  The info line contains
  378. diverse information about how the user has the program configured.
  379. On the left is the status of the keypad with the condition listed to the
  380. right.  A NUM means that the normal characters are sent.  In APPLICATION
  381. mode (APPL) the keys respond as expected depending on the terminal
  382. emulation selected.  Explaination of this subject will be found in the
  383. chapter discussing the keyboard.
  384.  
  385. With the right mouse button the user can select the view buffer screen.
  386. The window has a vertical scroll bar now, allowing the user to wander
  387. through the buffer.  With the cursor up and down keys the user can also
  388. scroll, while in connection with the SHIFT key even sideways.
  389.  
  390. Close the window when run as an application, and the program ends.  In
  391. accessory mode it only shifts to a standby condition.  Open the window
  392. again, and the RUFUS accessory returns to the previous condition.
  393.  
  394.  
  395.  
  396.  
  397.  
  398. - 6 -
  399.  
  400. Chapter 3
  401. The Menu
  402.  
  403.  
  404. 3.1       The File Menu
  405.  
  406. Under the title 'Files' are gathered the functions which deal with the
  407. mass storage devices in general.  By the way, batches and programs may
  408. also be started from here.
  409.  
  410. 3.1.1     INF Load...
  411.  
  412. With this function the user can load INF files.  These are where all the
  413. paramters for RUFUS are stored.  The user can have different configuration
  414. files stored and use them.  When selected, this brings up a standard file
  415. selector box allowing selection of the INF file.  The standard path can
  416. be set in the menu Parameter Path Select.
  417.  
  418. 3.1.2     INF Write...
  419.  
  420. With this the user can create files containing the actual parameter
  421. settings for his version of RUFUS.  The File Selector box appears with
  422. the specified Parameter path selected and RUFUS.INF as the file name.
  423. So just by pressing RETURN the user can complete the action quickly.
  424.  
  425. 3.1.3     EXecute Program...
  426.  
  427. Sometimes it is useful to run other programs without leaving the terminal
  428. program first.  RUFUS offers several possibile ways to do so.  Selecting
  429. the menu item brings up a file selector so the user can select a program
  430. to run.  Next a dialog will ask for the parameters the program expects
  431. to have to run.  If the program selected has a suffix of TOS or TTP RUFUS
  432. shifts into the VT52 emulation mode and the program runs in the window.
  433. Otherwise, the window will be closed and then the program run.  When done,
  434. control is returned to RUFUS.
  435.  
  436. 3.1.4     Shell Access
  437.  
  438. This function is only accessable when the user has installed a command
  439. line processor that has a shellpointer correctly set up.  Two that come to
  440. mind are GEMINI and MUPFEL from Stefan Eissing and Gereon Steffens.  With
  441. Run SHELL this program can pass one command for processing.  The response
  442. that is returned is either placed in the RUFUS window or the effect is
  443. noticed over the whole program.  This in the menu Parameter Terminal is
  444. selected.
  445.  
  446. 3.1.5     Batch Start...
  447.  
  448. A RUFUS batch program can be started with this function.  RUFUS programs
  449. are TEXT files containing commands which RUFUS can understand and act on.
  450. A complete discussion of the commands and their syntax can be found in the
  451. chapter "The Programming Language".
  452. Also here a File Selector appears allowing selection of the Batch file.
  453.  
  454.  
  455.  
  456. - 7 -
  457.  
  458. 3.1.6     Give Batch Command
  459.  
  460. With this one a single command of the Programming Language of RUFUS can be
  461. executed.  This is a good way for the user to try them out.
  462.  
  463. 3.1.7     Quit
  464.  
  465. After a dialog asking to save the buffer, RUFUS is exited from here.  If
  466. RUFUS is installed as an accessory, only the window is closed.
  467.  
  468.  
  469. 3.2       The 'Block' Menu
  470.  
  471. Under this menu title are functions concerning block manipulation.  Blocks
  472. can be marked in view mode, the desired section marked by clicking and 
  473. holding the mouse button, then dragging the mouse above or below that
  474. point.  In Version 1.02 blocks are still not depicted as being marked.
  475.  
  476. 3.2.1     Block Save...
  477.  
  478. Calls the File selector box to allow the user to specify the name under
  479. which the marked block should be saved.
  480.  
  481. 3.2.2     Block Send
  482.  
  483. The marked block will be sent over the serial port through the modem.
  484.  
  485. 3.2.3     Copy To Clipboard
  486.  
  487. The marked block is copied to the GEM Clipboard folder.  If the Clipboard
  488. is not found, RUFUS creates one.  [Clipboard is the accessory found with
  489. the GEMINI package.]
  490.  
  491.  
  492. 3.3       The 'Transfer' Menu
  493.  
  494. Under this title the user will find the functions to transfer files over
  495. the serial port - modem.
  496.  
  497. 3.3.1     File Send...
  498.  
  499. One file, with the currently selected protocal, is sent.  The protocal
  500. can be selected in the Protocal menu (section 3.4.3).  The desired file
  501. can be selected with the File Selector box presented.
  502.  
  503. 3.3.2     File Receive...
  504.  
  505. This will receive one file using the preselected transfer protocal.  The
  506. protocal can be selected in the Protocal menu (section 3.4.3).  The name
  507. can be selected through the File Selector box.  The exception is ZMODEM,
  508. where the file name is received from the sender.
  509.  
  510.  
  511.  
  512. - 8 -
  513.  
  514. 3.3.3     ASCII File Send...
  515.  
  516. One file, without any protocal, is sent.  Here also will appear the File
  517. Selector box allowing the file to be chosen.  A box with a gray bar to
  518. show transfer progress will appear.
  519.  
  520. 3.3.4     Buffer Load...
  521.  
  522. This makes it possible to load the capture buffer from disk.  With the
  523. File Selector the desired file is selected. [Note: The buffer must be 
  524. switched ON before this option is selected.  See section 3.4.7 on how to
  525. select buffer options.]
  526.  
  527. 3.3.5     Buffer Save...
  528.  
  529. All the captured data in the buffer can be saved to one file with this
  530. function.  The file name may be selected with the File Selector.
  531.  
  532.  
  533. 3.4       The 'Parameter' Menu
  534.  
  535. With the menu selections found under this title all parameters of RUFUS
  536. can be adjusted.
  537.  
  538. 3.4.1     RS232
  539.  
  540. After selecting this item, it produces a dialog box in which all options
  541. for the serial port can be set.  The default setting is 8 data bits, no
  542. parity, 1 stop bit and no handshaking.  The parameters are preset at most
  543. bulletin board systems and also at mainframes, and must be determined.
  544. Most give them in short form such as 2400baud/8N1.
  545. Choosing OK will set the port to the specified options and with CANCEL,
  546. the previous settings are retained.  The left and right cursor keys are
  547. an alternate method of setting the baud rate to be used.
  548.  
  549. 3.4.2     Terminal
  550.  
  551. In this dialog box all the choices are given for the look and emulation
  552. mode of the terminal to select.  The first choice is emulation.  RUFUS
  553. offers three terminal emulations:
  554. 1. VT52  -  This is one emulation of the DEC terminals.  This format is
  555. what the ATARI ST system uses, the auto folder programs use this before
  556. the other portions of the system are enabled.
  557. 2. VT100 -  The current standard terminal from DEC.  In this emulation
  558. mode, RUFUS also handles codes for VT2XX terminals and the ANSI codes.
  559. 3. ASCII -  No emulation.  All characters shown as given.
  560.  
  561. The next item is Echo Mode.  FULLDUPLEX means that all characters from the
  562. keyboard are sent only to the serial port.  HALFDUPLEX puts the characters
  563. on the terminal screen also and LOCAL-MODE writes the characters only in 
  564. the screen.
  565.  
  566.  
  567.  
  568. - 9 -
  569.  
  570. At LineEnd the user can select what happens when the terminal screen
  571. reaches the end of the line.  BREAK means that a line feed and a
  572. carriage return are automatically placed and the text is continued on 
  573. the next line.  WRAP pulls the complete word into the next line (not
  574. implemented in this version [1.02]).  OVR means that the remaining 
  575. characters are simply written over each other in the last character spot.
  576.  
  577. Where V52 only offers inverse text for special effect, RUFUS offers the
  578. possibility of inverse, thickened, or underlined text.
  579.  
  580. The number of lines and columns for the terminal window can be freely set
  581. in RUFUS.  The default and most popular is 80X24 (as the VT100 and VT52
  582. use) or 80X25 (VT52 under TOS).
  583.  
  584. Included in this dialoge as still six other options to set.  The first
  585. option selects whether new line should be sent as only a carriage return
  586. or coupled with a linefeed also.  With the second the user can select
  587. whether, when backspacing, if the character under the cursor is erased
  588. or remains visible.  The third option selects whether the responses from
  589. a shell program are written in the RUFUS window or windows are closed to
  590. allow the program to run on the whole screen.  Many mainframes, in spite
  591. of the 8 bit conection, can handle only 7 bit data through the RS232 port.
  592. The high bit can be stripped, or allowed through by setting the fourth
  593. option.  The fifth option selects whether the keypad is in ATARI mode
  594. or terminal emulation mode.  With the sixth and last option the user can
  595. remove the status line from the terminal window.  One more line can then
  596. be viewed on screen. [Usefull on medium resolution ST screens.]
  597.  
  598. 3.4.3   Protocall
  599.  
  600. After selecting this option one dialog box opens where all parameters for
  601. the file transfer protocalls can be selected and set.  RUFUS offers the
  602. choice of five protocalls:  XMODEM, YMODEM, YMODEM-G, ZMODEM, and STREAM.
  603. The first three mentioned may be run in the background.  ZMODEM calls on
  604. the programs RZ.TTP and SZ.TTP.  STREAM exists (till now) only in RUFUS.
  605. It lends itself especially to file transfers on error free lines (computer
  606. to computer, MNP-5), and works only with a handshaking control (XON/XOFF,
  607. RTS/CTS).
  608. On the right side the user finds a box with two buttons active only when
  609. RUFUS is installed as an ACCessory.  With the first button, it can be
  610. selected whether file transfers are expected to run in the background.
  611. With the second, whether or not to return to a RUFUS window at the end
  612. of a file transfer can be selected.
  613. Users who select ZMODEM to transfer files normally do not get a file
  614. selector dialog when ZMODEM starts.  If they desire one, this may be
  615. selected in the Protocall Dialog Box.  The option strings for the ZMODEM
  616. programs RZ and SZ can be given in this dialog also.  The string "-B" is
  617. given for both strings which means use default settings.
  618.  
  619.  
  620.  
  621.  
  622. - 10 -
  623.  
  624. 3.4.4   Modem
  625.  
  626. For the modem, RUFUS gives much choice to parameter setting.  Before and
  627. after all the desired communication, RUFUS is required to pass one modem
  628. command to assure it works.
  629. The first string is the Dial command.  This must end with a carriage
  630. return (CNTRL-M).  A number sign ('#') stands for the selected telephone
  631. number.
  632. The second string is sent before the call and is a modem reset command.
  633. Here also a carriage return is required.  Most modems after a reset cannot
  634. accept commands for a few moments, it is therefore necessary to pause.
  635. This is represented in the string with the CTRL-I characters.  Each
  636. gives a half second pause.
  637. The following string is the message from the modem after a successful
  638. connection.  The next three strings are the negative messages.  RUFUS
  639. uses these for auto redial.
  640. At the end come some switch for more options.  Automatic Baud rate
  641. Selection means RUFUS uses the modem's answer message and GGF [TR ?]
  642. to select the baudrate.
  643. If RUFUS has the Automatic Redial selected, it is to protect the modem
  644. that it pauses a while, allowing the phone line to clear.  The time length
  645. of the pause can be set to the user's preference.  RUFUS cancels at user's
  646. request dialing the modem.  This is the last command here.
  647.  
  648. 3.4.5   F' Keys
  649.  
  650. RUFUS offers 20 freely modifiable Function keys: ten normal and 10 shifted.
  651. One benefit is the user can place a batch file name into a function key,
  652. and when that key is pressed, RUFUS immediately executes that batch.  The
  653. file name must be preceeded by the '&' symbol.  Similarly, the user can
  654. call one batch command with a function key by placing the '%' symbol in
  655. front of the command.
  656. Examples:
  657. %DIAL "1234" Dials the number 1234.
  658. &RUFUS.RUF   Executes the batch file RUFUS.RUF.
  659.  
  660. 3.4.6   Numbers
  661.  
  662. In this dialog box are the settings for BBS system dial ups.  On the right
  663. side, the user finds the name of the currently selected BBS.  Through
  664. selective clicking with the mouse, the different fields can be selected
  665. and edited with the new name showing up in the box to the left.  With a
  666. double click on the name or through the "Dial" button below, the call
  667. will be started.  Alternately, the user can select any of the sixteen 
  668. numbers to be dialed with the F1 through F10 and shifted F1 through
  669. shifted F6 keys.
  670. There are only eight of the 16 numbers visible in the window at a time,
  671. using the scroll bar the others can be viewed. Shift UP Arrow or Shift
  672. Down Arrow also scrolls the window.
  673. Underneath the editable fields the user can select whether several numbers
  674. can be selected to dial.  All numbers in the list will be dialed one by
  675. one by RUFUS until a connection is made.  With the next selection the
  676. automatic dial function can be selected.  RUFUS then dials one or all
  677. numbers until a connection is made, or the user cancels.  The auto dial
  678. feature needs the Failure Codes from the MODEM to work properly (3.4.4).
  679.  
  680.  
  681.  
  682.  
  683. - 11 -
  684. 3.4.7     Buffer
  685.  
  686. The buffer is a special storage place in which everything comming in the
  687. serial port is collected without terminal protocal.  In the Buffer Size
  688. entry one can adjust how big the buffer should be.  Under this are four
  689. other selections.
  690. The first selection is whether the incomming data should be written to the
  691. buffer or not.  The next is whether to warn the user before a buffer is
  692. erased.  Turn this warning on, and the user can decide whether the buffer
  693. is lost or saved.  Should the buffer not be lost, writing to the buffer
  694. is switched off.
  695. With the middle switch, the user selects if a full buffer is automatically
  696. saved and whether or not it is appended to a file if that file already
  697. exists.  If this last is not active, RUFUS may eventually lose a file by
  698. writing over the exisiting one.
  699.  
  700. The name, under which RUFUS will automatically save, can be specified in
  701. the menu.  There the user can give the control codes from the following
  702. table:
  703. %a Abbreviated Weekday name          %A Full weekday name 
  704. %b Abbreviated Month name            %B Full month name 
  705. %c Date and time                     %d Day of month (1-31) 
  706. %H Hour (0-23)                       %I Hour (0-12) 
  707. %j Day of year (1-366)               %m Month (1-12) 
  708. %M Minute (00-59)                    %p AM/PM 
  709. %S Second (00-59)                    %w Day of week (0-6) 
  710. %W Week of year (0-52)               %x Local date representation 
  711. %X Local time representaion          %y Year without century (0-99) 
  712. %Y Year with century                 %Z Timezone name (produces: MEZ) 
  713. %% The '%' character 
  714. [These codes are the same as specified in ANSI C for time / date string
  715. formatting.]
  716.  
  717. So by specifying RC%y%m%d.TXT on 11 Nov 1990 the file RC901111.TXT would
  718. be the result.  The selection ERASE erases the buffer, while SAVE will
  719. write the buffer to disk.  ERASE also can be accessed with the keyboard
  720. combination ALT-Y and SAVE with ALT-G.
  721.  
  722. 3.4.8     Set Fontz
  723.  
  724. RUFUS loads existing fonts over GDOS.  In the menu Set Fonts the user can
  725. dial type and size, as he chooses.  RUFUS uses only a single font, and
  726. not porpotionally.  When changing the font by the user in the menu, RUFUS
  727. shows the smallest available size.
  728. A peculiarity is the system font (6x6 built in).  There TOS hides the
  729. three system fonts.  With a point size of 8 the user gets the 6x6 font, 9
  730. point is the 8x8 font and 10 selects the 16x8 font.
  731. If GDOS is unavailable when requested by RUFUS, only the font RUFUS.FNT
  732. gets loaded.  When not loaded when the computer boots, the user has
  733. none but the 6x6 system font in three sizes.
  734.  
  735.  
  736.  
  737. - 12 -
  738.  
  739. 3.4.9     Disk Paths
  740.  
  741. RUFUS manages many different paths.  The first tells where RUFUS will load
  742. Batch files from.  The second path informs RUFUS where the files to be 
  743. uploaded are.  The path where the INF files are kept is given by the third
  744. path.  With the next path setting for the user, the buffer write location
  745. is given.  With the fifth path, the user can specify where the programs
  746. RZ.PRG and SZ.prg for ZMODEM transfer are to be found.  The last path is
  747. for the downloaded programs' placement.
  748. All paths can always by typed by hand by the user or also with the file
  749. selector box when the user clicks on the path input line.
  750.  
  751.  
  752. 3.5       The "POP-UP" Menu
  753.  
  754. Since accessories have no pull down menus available, RUFUS uses Pop Up
  755. menus when in accessory mode.  The user can access the menu with a click
  756. in the window or by pressing the HELP key.  With the gray bar the menu
  757. can be moved around.  By dragging in the menu, and holding with the arrow, 
  758. the items under the menu will click into place.
  759.  
  760.  
  761.  
  762.  
  763.  
  764. - 13 -
  765.  
  766. Chapter 4
  767. Terminal Emulations
  768.  
  769.  
  770. 4.1     VT52
  771.  
  772. VT52 is a simple terminal.  Almost all known BBS systems understand the
  773. VT52.  The codes are the same used by the TOS window management system.
  774. The VT52 mode is what the ST enters when a TOS or TTP program is started
  775. or a Shell program is used.  The VT52 emulation is similar to VT100, the
  776. later has more codes.  By the way, the keypad is now in original VT52
  777. form.
  778.  
  779.  
  780. 4.2     VT100
  781.  
  782. VT100 is by far the world standard terminal.  Nearly every BBS system and
  783. mainframe computer understands this terminal format.  Only very few of
  784. the commercial telecom programs come without a VT100 emulation.  Therefore
  785. it is self evident that RUFUS had to emulate this terminal.  RUFUS can
  786. understand almost all current features of the VT100, as far as is possible
  787. on a computer with graphics as simple as the ST.  Underlined interlaced
  788. mode is not possible with the SM124 monitor.  Just as "SELFTEST" is
  789. irrelevant.  The codes to implement those VT100 functions are ignored.
  790.  
  791. 4.2.1   ANSI Mode
  792.  
  793. ANSI is the American norm (corresponding to DIN in Germany).  Also, the 
  794. control codes for terminals have only recently been set.  The ANSI codes
  795. are practically identical to the VT100.  The character sets are different,
  796. however.  The major differences are incorporated into RUFUS.  The most
  797. use of ANSI is in the MSDOS area, there the interface is handled through
  798. the PC program ANSI.SYS to ANSI terminal mode.  To accomodate this, RUFUS
  799. has three character sets with all the ANSI characters included: RUFUS9,
  800. RUFUS10, RUFUS12.  The numbers in the names gives the point size.  Since
  801. all are GEM fonts, they can only be accessed with GDOS installed.
  802.  
  803. 4.2.2   VT2XX Emulation
  804.  
  805. Following the VT100, terminals of the VT2XX series were produced.  The 
  806. important difference from the VT100 is all characters are in full 8-bit
  807. mode.  This allows the control codes starting with ESC[ to occupy a single
  808. character (CSI).  As with ANSI, here RUFUS can handle the important codes.
  809.  
  810.  
  811.  
  812.  
  813.  
  814. - 14 -
  815. Chapter 5
  816. The Keyboard
  817.  
  818. 5.1     General Keys
  819.  
  820. There are terminals with keys serving special functions, RUFUS also has
  821. ways for keys to serve those functions.  The menu of RUFUS can be reached
  822. by keys.  Also, built into those menus are always key access.  When inside
  823. a dialog box and the user can click to set a parameter (Terminal mode,
  824. RS232 baud rate) so can these also be assigned to happen with the press of
  825. a function key.  Also, by the way, in the RS232 Menu the baud rate can be
  826. adjusted with the cursor-left and cursor-right keys.  The complete list
  827. of key combinations is in Appendix B.
  828.  
  829. The combination with the Alternate key is needed because of the connection
  830. with the Control key to BBS system and mainframe service (i.e. CTRL-C or
  831. CTRL-X).
  832.  
  833. The Function keys are a perfect example.  When the user is in terminal
  834. mode of RUFUS, pressing any function key will cause the whole sequence
  835. previously entered in the Function Key Definition menu to be sent.  The
  836. exception is when the function key is loaded with a batch file or shell
  837. commend.  [Then either that batch is executed or the command is passed to
  838. the shell.]
  839.  
  840. In accessory mode the Help key has the effect of causing the Popup menu
  841. to shoot onto the screen.  Pressing the Undo key causes the window to
  842. close, until the next call to run.
  843.  
  844. 5.2     Special Terminal Keys
  845.  
  846. No matter how close the emulation of the terminal is brought, is is
  847. necessary that some keys be left undefined.  So, to represent the 
  848. BREAK signal, the combination ALTERNATE-ESC is used.
  849.  
  850. 5.2.1    Keys in the VT52 Emulation
  851.  
  852. The VT52 emulation sends the corresponding VT52 codes for each cursor
  853. key pressed.  Also, HOME and CLR supply the proper codes.  When the user
  854. has the keypad in application mode, the keys (, ), /, * form the keys PF1
  855. through PF4.
  856.  
  857. 5.2.2    Keys in the VT100 Emulation
  858.  
  859. The VT100 emulation sends the corresponding VT100 codes for each cursor
  860. key pressed.  Also, HOME and CLR supply the proper codes.  When the user
  861. has the keypad in application mode, the keys (, ), /, * form the keys PF1
  862. through PF4.
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869. - 15 -
  870.  
  871. Chapter 6
  872. File Transfer
  873.  
  874.  
  875. 6.1       ASCII
  876.  
  877. The ASCII transfer is a protocal free transfer, that is, the files are
  878. sent without reguard for loss.  This kind of transfer is specially suited 
  879. for when the user has prepared text files and would like to transmit them
  880. to an online system.
  881.  
  882.  
  883. 6.2       XMODEM
  884.  
  885. XMODEM is the best simple protocal for file transfers.  Almost every host
  886. computer and online system supports XMODEM for binary data sending.
  887. XMODEM can be used by RUFUS in the background.
  888.  
  889.  
  890. 6.3       YMODEM
  891.  
  892. YMODEM is an expansion of XMODEM.  Larger blocks and CRC checksumming make
  893. for a faster and safer file transfer.  Most YMODEM implementations (YMODEM
  894. Batch) can transmit the file name and the size.  RUFUS is unable to do
  895. that.  As with XMODEM, YMODEM can also run in the background.
  896.  
  897. 6.3.1     YMODEM-G
  898.  
  899. A separate variant of YMODEM is YMODEM-G.  YMODEM-G is faster than YMODEM.
  900. However,it cannot recover when an error crops up.  YMODEM-G is for error
  901. free transfers through the appropriate MNP5 system.
  902.  
  903.  
  904. 6.4       ZMODEM
  905.  
  906. ZMODEM is presently the most powerfull file transfer protocal and itself
  907. pleasantly always shows great stoutness. RUFUS uses this protocal through
  908. the programs RZ.PRG and SZ.PRG.  Since ZMODEM is not runable in the
  909. background, the user may always use XMODEM or YMODEM.
  910.  
  911.  
  912. 6.5       STREAM
  913.  
  914. STREAM is a specialty of RUFUS.  STREAM is especially designed for error
  915. free phone lines (MNP5 or null modem). The disadvantage is that, even now
  916. none but RUFUS supports this protocal.  However it is about 20% faster
  917. than ZMODEM.
  918.  
  919.  
  920.  
  921.  
  922.  
  923. - 16 -
  924.  
  925. Chapter 7
  926. Modem Usage
  927.  
  928.  
  929. 7.1       The Correct Parameters
  930. RUFUS is right flexible when passing strings to and from the modem.  The
  931. user can give the dial string not only a prefix but also a suffix. The
  932. possibilities are endless, passing a string so complex it befuddles you.
  933. In the Modem Parameter dialog six possible strings can be inserted.  The
  934. first two are commands to be given to the modem.  Both must end with a
  935. carriage return.  The user can give this with the key combination of
  936. CONROL-M.
  937. When the modem is reset, the user must pause before sending more to the
  938. modem.  Through use of the key combination CONTROL-I one can get a half
  939. second pause.
  940. The dial string can contain one additional code.  The character '#'
  941. informs RUFUS to put the desired phone number in its place.  The following
  942. strings will control a Hayes AT standard modem:
  943. RESET:  ATZ<CONTROL-M><CONTROL-I><CONTROL-I>
  944.      ATZ  Command to reset modem
  945.      <CONTROL-M>     RETURN, send modem command out.
  946.      <CONTROL-I>     half second pauses. At least a pair is needed.
  947.  
  948. DIAL:   ATDP#<CONTROL-M>
  949.      ATDP Command to pulse dial (use ATDT for tone).
  950.      #    number.
  951.      <CONTROL-M> end the command.
  952.  
  953. The three next strings are ones the modem sends when it is unsuccessful at
  954. dialing the given number.
  955. The user should place the modem responses for no response there (BUZY etc.).
  956.  
  957.  
  958. 7.2       Editing the Numbers
  959. Phone numbers are given in the Number dialog.  To set the system name or
  960. other information, the user must first click on the number.  Now will
  961. appear to the right the info.  Name, telephone number and a Batch can be
  962. inserted.  The Batch is a RUFUS Batch Program constructed according to the
  963. instructions in chapter eight.
  964.  
  965.  
  966. 7.3       Dialing a Number
  967.  
  968. From the Number Dialog there are three ways one number can be dialed.  The
  969. user can simply click on the number and then click on the choose button.
  970. Also it is possible to double click on the number.  And last, by keypress
  971. a number can be chosen.  The keys F1 to F10 dial the first 10 numbers,
  972. while the key combination SHIFT-F1 through SHIFT-F6 dial numbers 11 thru
  973. 16.
  974. There lies much more to the box, and for the user who cannot be present
  975. between calls, RUFUS offers an automatic operation.  As long as one of the
  976. three modem failure strings is received, RUFUS will try to call again.
  977. The time between two call attempts can be adjusted in the box also.
  978.  
  979.  
  980.  
  981.  
  982. - 17 -
  983.  
  984. 7.4       Dialing More Numbers
  985.  
  986. RUFUS offers the possibility of dialing many different numbers until a
  987. connection is made with one.   To have this occur the corresponding button
  988. must be switched on in the Numbers box.  Now the numbers can be dialed
  989. and tried out.  With a click choose START to continue.  If the auto dial
  990. switch is on, after unsuccessfully calling all the numbers RUFUS will
  991. begin again from the beginning.
  992.  
  993.  
  994.  
  995.  
  996.  
  997. - 18 -
  998.  
  999. Chapter 8
  1000. The Programming Language
  1001.  
  1002.  
  1003. 8.1       Overview
  1004.  
  1005. RUFUS contains its own programming language.  With programming allowing
  1006. accumulation of many repeated instructuctions, like in logging in,
  1007. automation is possible.  The RUFUS programs (short batch) are simply ASCII
  1008. text in which each line has one command.  If the first character in the
  1009. line is a semicolon, the entire line can be used for giving comments.
  1010. A batch can be broken off with a CTRL-X keypress.  Exception is the DIAL
  1011. command which can be manually cancelled with one of the keys SHIFT,
  1012. ALTERNATE, CONTROL or broken off with the Mouse buttons.  When the user
  1013. needs to supply a file name (such as in UPLOAD), RUFUS will call the File
  1014. Selector box. 
  1015.  
  1016.  
  1017. 8.2       Variables
  1018.  
  1019. Variables are denoted with a '$' followed by a whole number between 0 and
  1020. 99.  $0 is automatically used, when none or an invalid variable (i.e $100)
  1021. is given.  The user is not obliged to become familair with its contents,
  1022. with the next command always changing it.
  1023.  
  1024. Some special variables available, naturally, must not be skipped.
  1025. $F1-$F10, $SF1-$SF10 set the contents of the Function keys.
  1026. $N1-$N16 stand for the telephone numbers in RUFUS' list.
  1027. $UE has a dialog box outcome, in the application use can be made of it. Gone
  1028. $D  has the Fileselector outcome.
  1029. Special variables can in these applications be used.
  1030. The user must quote (i.e. " ") all strings.
  1031.  
  1032. $0-$99, $n1-$n16 are numerical variables
  1033. $d, $f1-$f10 and $sf1-$sf10 are string variables
  1034. $ue is allowed to be used with both 
  1035.  
  1036.  
  1037. 8.3       Labels and Branching
  1038.  
  1039. Labels or branch markers consist of a whole number between 0 and 255
  1040. followed by a colon (45:).  GOTO, GOSUB, RETURN and IF can act on these
  1041. labels.  Label 0 should not be used, it is needed for GOSUB-RETURN to
  1042. function.
  1043.  
  1044.  
  1045. 8.4     The Commands
  1046.  
  1047. ADD var value1 value2
  1048. adds the two items specified by value1 and value2 and places result into
  1049. var.
  1050.  
  1051. Example: ADD $1 $2 4
  1052. the value 4 is added to the contents of variable $2 and the result is put
  1053. in variable $1.
  1054.  
  1055.  
  1056.  
  1057.  
  1058. - 19 -
  1059.  
  1060. ALERT [var] form_string 
  1061. RUFUS produces a GEM alert.  The button selected will be stored in the
  1062. optional variable. Form_string is formated as: [Icon-Number][text][button]
  1063.  
  1064. Example: ALERT $4 "[3][Das ist das Ende][OK|NEIN]"
  1065. Following exit from the Alert, the number of the button chosen will be in
  1066. variable $4.
  1067.  
  1068. BAUDRATE baudrate|var
  1069. Baudrate set or inquired respectively.
  1070.  
  1071. Example:
  1072. BAUDRATE 2400   sets to 2400 Baud
  1073. BAUDRATE $1  Determines the current baud and stores value in varable $1.
  1074.  
  1075.  
  1076. BELL 0|1
  1077. With BELL the user can produce an acoustic signal. BELL 0 gives a ring,
  1078. BELL 1 a dull tone.
  1079.  
  1080.  
  1081. CLEARBUFFER
  1082. Capture buffer is emptied.
  1083.  
  1084.  
  1085. CLR
  1086. Sends a Terminal reset command.
  1087.  
  1088.  
  1089. CRLF
  1090. Turns the automatic Linefeed delivery on.
  1091.  
  1092.  
  1093. DIAL [var] fonenumber
  1094. A phone number out of the register will be dialed.  Automatic settings
  1095. (Dial, Baudrate) will be followed.  Success or failure of the call will
  1096. be written to the supplied variable.  There are only five possible values
  1097. returned:
  1098. -2 = connection broken
  1099.  0 = Dialed successfully
  1100.  1 = Failure#1 (your Modem parameter)
  1101.  2 = Failure#2
  1102.  3 = Failure#3
  1103.  
  1104.  
  1105.  
  1106. - 20 -
  1107.  
  1108. Example:
  1109. DIAL $N3  dials the third number in the Number list
  1110. DIAL "1-202-736-5000"  dials the number in the quotes (the White House).
  1111. DIAL "CompuServe" dials the number of CompuServe if the BBS name and info
  1112.      are entered in the Numbers Dialog. [NEW for version 1.06]
  1113.  
  1114. DIV var value1 value2
  1115. Divides value2 by value1 and places result in var.
  1116.  
  1117. Example: DIV $1 $2 4
  1118. The value 4 is divided by the contents of variable 2 and the result is
  1119. placed into variable 1.
  1120.  
  1121.  
  1122. DOWNLOAD [var] filename
  1123. Attempts to download the file using the previously selected protocal.
  1124. Reports the result in the specified variable.
  1125.  
  1126. Example: DOWNLOAD $1 "OUTFILE.ARC"
  1127.  
  1128.  
  1129. END
  1130. Exit a batch before the end of the file.
  1131.  
  1132.  
  1133. FDELETE [var] filename
  1134. Erases the file. Success or failure is reported in the variable.
  1135.  
  1136.  
  1137. FILEEXIST [var] file_name
  1138. Investigates the existance of the File and writes the result in the
  1139. variable.  0 means that the file does not exist.
  1140.  
  1141.  
  1142. GOSUB label|var
  1143. Branch to the desired label (see also GOTO). The actual return position
  1144. will be marked by label 0 and with RETURN command can be reached.  The
  1145. user can provide a variable instead of a constant label making indirect
  1146. branches possible.
  1147.  
  1148. Example:
  1149. GOSUB 3  branches to label 3
  1150. GOSUB $3  branches to label number in variable $3.
  1151.  
  1152.  
  1153. GOTO label
  1154. Branches to the desired label if it exists, otherwise branches to the end
  1155. of the batch.  Instead of a constant label, a variable can be used making
  1156. indirect branching possible.
  1157.  
  1158. Example:
  1159. GOTO 3  branches to label 3
  1160. GOTO $3  branches to label number in variable $3.
  1161.  
  1162.  
  1163.  
  1164.  
  1165. - 21 -
  1166.  
  1167. IF condition n1 n2 label
  1168. When the condition is fulfilled, a branch is taken to the label, otherwise
  1169. it falls through to the next command.  n1 and n2 are numeric expressions
  1170. and can also be variables or constants.  The condition can be one of the
  1171. following:
  1172. EQ      var == constant
  1173. NE      var != constant
  1174. GE      var >= constant
  1175. LE      var <= constant
  1176. GT      var >  constant
  1177. LT      var <  constant
  1178. the branch succeeds as with GOTO.
  1179.  
  1180. Example: IF EQ $1 0 4
  1181. Compares the contents of variable $1 to see if equal to 0.  When true
  1182. a branch off to label 4 is taken.
  1183.  
  1184.  
  1185. LET var value
  1186. places the value into the variable.
  1187.  
  1188. Example: LET $1 4
  1189. Writes in $1 a 4.
  1190.  
  1191.  
  1192. LOADINF file_name
  1193. RUFUS configuration file is loaded.
  1194.  
  1195.  
  1196. MUL var value1 value2
  1197. Multiplies the two values and places result into the variable.
  1198.  
  1199. Example: MUL $1 $2 4
  1200. The value 4 is multiplies by value in variable $2 and the result is put
  1201. into variable $1.
  1202.  
  1203.  
  1204. NOCRLF
  1205. Turns the automatic linefeed off.
  1206.  
  1207.  
  1208. PRINT string[-] | \nnn | var [-] |
  1209. Puts out either a string or a character with ASCII code nnn into the
  1210. terminal window.  A CR will automatically be sent, unless a '-' is the
  1211. last character in the string.  It is also allowed to use the variables
  1212. $ue, $d, $f1-$f10, $sf1-$sf10 and $n1-$n16.  Then it is necessary that
  1213. eventually a null character follows the '-' to keep the variables existing
  1214. separately.
  1215.  
  1216. Example:
  1217. PRINT "HALLO" gives HALLO in the Terminal.
  1218. PRINT \027  writes an ESC at the Terminal.
  1219.  
  1220.  
  1221.  
  1222.  
  1223. - 22 -
  1224.  
  1225. PROTOKOLL protocal
  1226. With this command the user can sellect the transfer protocal.  The 
  1227. following protocal names are acceptable: XMODEM,YMODEM,ZMODEM,ASCII and
  1228. STREAM. Giving the first letter of the term is sufficient.
  1229.  
  1230.  
  1231. QUIT
  1232. RUFUS will first question if the user is certain.
  1233.  
  1234.  
  1235. RETURN
  1236. Return from a subroutine. RETURN is identical to GOTO 0.
  1237.  
  1238.  
  1239. RUN file_name [cmdline]
  1240. Start a programme.
  1241.  
  1242. Example:RUN "TEMPUS.PRG" $ue
  1243. Start Tempus and give the supplied parameter.
  1244.  
  1245.  
  1246. RWAIT [var] string [timeout]
  1247. RWAIT waits till the specified string is received.  Not breaking till the
  1248. time set as timeout is reached, a value of 0 means success, otherwise a
  1249. value not equal to 0 means failure.  The exact failure codes have not yet
  1250. been finalized.
  1251. If an '&' is the first string character, it is ignored and for the rest of
  1252. the string no distinction is made, while waiting, for upper- and lowercase
  1253. characters.  Also the last parameter can specify the timeout time.
  1254. If TIMEOUT = 0, RWAIT waits FOREVER.
  1255.  
  1256. Example: RWAIT $1 "&username" 10
  1257. Wait a maximum of 10 seconds for the supplied string, ignoring upper/lower
  1258. case.
  1259.  
  1260.  
  1261. SAVEBUFFER file_name
  1262. Writes the Buffer to the specified file.  Buffer Options settings are 
  1263. considered.
  1264.  
  1265.  
  1266. SEND string[-] | \nnn | var [-] |
  1267. Sends either a string or a character with ASCII code nnn.  A CR will be
  1268. automatically sent unless a '-' is the last character in the string.  It
  1269. is also allowable to use the variables $ue, $d, $f1-$f10, $sf1-$sf10 and
  1270. $n1-$n16.  Then it is necessary that eventually a null character follows
  1271. the '-' to keep the variables existing separately.
  1272.  
  1273. Example:
  1274. SEND "Tagchen"
  1275. SEND \027
  1276. SEND $ue
  1277.  
  1278.  
  1279.  
  1280.  
  1281. - 23 -
  1282.  
  1283. SUB var value1 value2
  1284. Subtract the values and leave the result in the variable.
  1285.  
  1286. Example: SUB $1 $2 4
  1287. The value 4 is subtracted from the value in variable $2 and the result is
  1288. placed in variable $1.
  1289.  
  1290.  
  1291. SYSTEM command
  1292. Pass a command to a shell such as: GEMINI, MUPFEL, MASTER.
  1293.  
  1294. Example: SYSTEM "ls -l"
  1295. List out a directory.
  1296.  
  1297.  
  1298. TERMINAL value|var
  1299. Set or inquire, respectively, the terminal mode.  Given values 0=ASCII,
  1300. 1=VT52 or 2=VT100, sets the emulation respectively.  Given a variable,
  1301. returns to the user the above respective value in the variable.
  1302.  
  1303. Example:
  1304. TERMINAL 1  set VT52 on.
  1305. TERMINAL $1 determine the current Emulation and write the value in $1.
  1306.  
  1307.  
  1308. TIMEOUT sec
  1309. Set Timeout value for WAIT and RWAIT.
  1310.  
  1311.  
  1312. UPLOAD [var] file_name
  1313. Send the file using the previously selected protocal and report back the
  1314. result in the variable.
  1315.  
  1316.  
  1317. WAIT [var] [constant]
  1318. Wait till the TIMEOUT preset time.  The time can be directly set.
  1319.  
  1320.  
  1321.  
  1322.  
  1323.  
  1324. - 24 -
  1325.  
  1326. APPENDIX A
  1327. Implementation of Terminal Emulation
  1328.  
  1329.  
  1330. VT52
  1331.  
  1332. ESC <        Enter VT100/ANSI Emulation
  1333. ESC =        Keypad in Application Mode
  1334. ESC >        Keypad in Normal Mode
  1335. ESC A        Cursor Up
  1336. ESC B        Cursor Down
  1337. ESC C        Cursor Right
  1338. ESC D        Cursor Left
  1339. ESC E        Terminal Reset
  1340. ESC H        Cursor Home
  1341. ESC I        Reverse Linefeed
  1342. ESC J        Clear Below Cursor
  1343. ESC K        Clear Remainder of Line
  1344. ESC L        Insert Line
  1345. ESC M        Delete Line
  1346. ESC Y pl pc  Position Cursor
  1347. ESC Z        Terminal Identification (RUFUS sends ESC / Z back)
  1348. ESC b        Foreground Color Set
  1349. ESC c        Background Color Set
  1350. ESC d        Clear Screen to Cursor
  1351. ESC e        Cursor On
  1352. ESC f        Cursor Off
  1353. ESC j        Save Cursor Position 
  1354. ESC k        Cursor to Saved Position
  1355. ESC l        Clear Current Line
  1356. ESC o        Clear Current Line to Cursor
  1357. ESC p        Inverse On
  1358. ESC q        Inverse Off
  1359. ESC v        Wrap On
  1360. ESC w        Wrap Off
  1361.  
  1362.  
  1363.  
  1364.  
  1365. - 25 -
  1366.  
  1367. VT100
  1368.  
  1369. ESC (A          Set UK character set to G0
  1370. ESC (B          Set ASCII character set to G0
  1371. ESC (0          Set graphics character set [line-drawing] to G0
  1372.         
  1373. ESC )A          Set UK character set to G1
  1374. ESC )B          Set ASCII character set to G1
  1375. ESC )0          Set graphics character set [line-drawing] to G1
  1376.  
  1377. ESC [2h         Keyboard lock
  1378. ESC [2l         Keyboard unlock
  1379. ESC [4h         Insert mode (*)
  1380. ESC [4l         Replace mode (*)
  1381. ESC [12h        Full duplex
  1382. ESC [12l        Half duplex
  1383. ESC [20h        CR instead of CRLF
  1384. ESC [20l        CR normal
  1385.  
  1386. ESC [?1h        Cursor key in Application mode
  1387. ESC [?1l        Cursor key in Cursor mode
  1388. ESC [?2l        Enter VT52-Emulation
  1389. ESC [?3h        132 column Mode
  1390. ESC [?3l        80 column Mode
  1391. ESC [?4h        Smooth Scrolling
  1392. ESC [?4l        Jump Scrolling
  1393. ESC [?5h        Inverse screen
  1394. ESC [?5l        Normal screen
  1395. ESC [?6h        Origin mode relative (*)
  1396. ESC [?6l        Origin mode absolute (*)
  1397. ESC [?7h        Wrap on
  1398. ESC [?7l        Wrap off
  1399. ESC [?8h        AUTO Repeat on (*)
  1400. ESC [?8l        AUTO Repeat off (*)
  1401. ESC [?9h        Interlace on (*)
  1402. ESC [?9l        Interlace off (*)
  1403.  
  1404.  
  1405.  
  1406. - 26 -
  1407.  
  1408. ESC [0m         No Attribute
  1409. ESC [1m         Fat characters on
  1410. ESC [2m         Solid pointer on (*)
  1411. ESC [3m         Script on
  1412. ESC [4m         Underline on
  1413. ESC [5m         Blink on (RUFUS clear)
  1414. ESC [6m         Fast Blink on (*)
  1415. ESC [7m         Inverse on
  1416. ESC [8m         Abgedunkelt on (*)
  1417. ESC [22m        Fat off
  1418. ESC [24m        Underline off
  1419. ESC [25m        Blink off
  1420. ESC [27m        Inverse off
  1421. ESC [30m        Black foreground
  1422. ESC [31m        Red foreground
  1423. ESC [32m        Green foreground
  1424. ESC [33m        Yellow foreground
  1425. ESC [34m        Blue foreground
  1426. ESC [35m        Purple foreground
  1427. ESC [36m        Cyan-blue foreground
  1428. ESC [37m        White foreground
  1429. ESC [40m        Black background
  1430. ESC [41m        Red background
  1431. ESC [42m        Green background
  1432. ESC [43m        Yello background
  1433. ESC [44m        Blue background
  1434. ESC [45m        Purple background
  1435. ESC [46m        Cyan-blue background
  1436. ESC [47m        White background
  1437. ESC [48m        Low level
  1438. ESC [49m        High level
  1439.  
  1440. ESC [ pn A      Cursor up pn lines
  1441. ESC [ pn B      Cursor down pn lines
  1442. ESC [ pn C      Cursor right pn lines
  1443. ESC [ pn D      Cursor left pn lines
  1444. ESC [ pl ; pc H Cursor Position
  1445. ESC [ pl ; pc f Cursor Position
  1446. ESC D           Index
  1447. ESC M           Reverse Index
  1448. ESC E           Nextline
  1449. ESC 7           Save cursor position and characteristics
  1450. ESC 8           Restore cursor "     and    "
  1451.  
  1452. ESC H           Horizontal Tab set
  1453. ESC [g          Tab clear
  1454. ESC [0g         Tab clear
  1455. ESC [3g         All Tabs clear
  1456.  
  1457. ESC #3          Double high, over half
  1458. ESC #4          Double high, under half
  1459. ESC #5          Standard high, standard Breite
  1460. ESC #6          Double Bright (*)
  1461.  
  1462.  
  1463.  
  1464. - 27 -
  1465.  
  1466. ESC [K          Erase from cursor to end of line
  1467. ESC [0K         Erase from cursor to end of line
  1468. ESC [1K         Erase from beginning of line to cursor
  1469. ESC [2K         Erase entire line
  1470.  
  1471. ESC [J          Erase from cursor to end of screen
  1472. ESC [0J         Erase from cursor to end of screen
  1473. ESC [1J         Erase from start of screen to cursor
  1474. ESC [2J         Erase entire screen
  1475.  
  1476. ESC c       Terminal Reset
  1477.  
  1478. ESC [5n     Status report
  1479. ESC [6n     Cursor position report
  1480. ESC [c      What Terminal type are you?
  1481. ESC [0c       "
  1482. ESC Z         "
  1483.  
  1484. ESC [ pt ; pb r Scroll region set
  1485.  
  1486. ESC [0q         all LED's off
  1487. ESC [ ps q      LED ps on
  1488.  
  1489. ESC [ pn P      Characters erase
  1490. ESC [ pn L      lines insert
  1491. ESC [ pn M      lines erase
  1492.  
  1493. ESC [s      Save Cursor position
  1494. ESC [u      Cursor Position restore
  1495.  
  1496. Also with the Control Code CSI all ESC [ codes are interpreted, so that
  1497. some VT2xx compatibility is possible.
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503. - 28 -
  1504.  
  1505. APPENDIX B
  1506. Keyboard Codes
  1507.  
  1508.  
  1509. ALT-A           ASCII File send
  1510. ALT-B           Batch file execute
  1511. ALT-C           Block copy to Clipboard
  1512. ALT-D           Path setting
  1513. ALT-E           File Download with current transfer protocal
  1514. ALT-F           Function key setting
  1515. ALT-G           Save the Buffers
  1516. ALT-H           Modem hangup, DTR line toggle
  1517. ALT-I           Save Parameter settings
  1518. ALT-J           Save the Blocks 
  1519. ALT-L           Parameter load 
  1520. ALT-M           Modem parameters
  1521. ALT-P           Transfer protocal select 
  1522. ALT-Q           RUFUS Exit 
  1523. ALT-R           RS232 settigns 
  1524. ALT-S           File Upload with current Protocal 
  1525. ALT-T           Terminal setting 
  1526. ALT-U           About RUFUS 
  1527. ALT-V           Shell command execute 
  1528. ALT-W           Dial Telephone number 
  1529. ALT-X           Programme execute 
  1530. ALT-Y           Buffer empty 
  1531. ALT-Z           Font select 
  1532. ALT-1           1200 Baud 
  1533. ALT-2           2400 Baud 
  1534. ALT-3           300 Baud 
  1535. ALT-4           4800 Baud 
  1536. ALT-9           9600 BAUD 
  1537. ALT-ESCAPE      curses Break 
  1538. SHIFT-ESCAPE    CSI 
  1539. SHIFT-ALT-B     Batch command execute 
  1540. SHIFT-ALT-M     STREAM select 
  1541. SHIFT-ALT-P     Buffer management 
  1542. SHIFT-ALT-S     Send Blocks 
  1543. SHIFT-ALT-U     Wrapmode select 
  1544. SHIFT-ALT-V     Terminal emulation setting 
  1545. SHIFT-ALT-X     XMODEM and CHKSUM select 
  1546. SHIFT-ALT-Y     YMODEM and CRC select 
  1547. SHIFT-ALT-Z     ZMODEM select 
  1548.  
  1549.  
  1550.  
  1551.  
  1552.  
  1553. - 29 -
  1554.  
  1555. APPENDIX C
  1556. Special Files
  1557.  
  1558.  
  1559. RUFUS.RUF - contains the default settings RUFUS uses when run.  When RUFUS
  1560. encounters file with this extension in the RUF folder, it is executed as
  1561. a Batch process.
  1562.  
  1563. RUFUS.FNT - this font is loaded by RUFUS when GDOS is not installed.  The
  1564. font must be in GEM Font format and nonporportional.
  1565.  
  1566. SZ.PRG and RZ.PRG are the programs which enable ZMODEM to operate.
  1567. With RZ the following parameters are possible: 
  1568. SZ can take a few parameters more: [Trans note: Parameters were missing from
  1569. the RUFUS.ARC file in all versions I could find. M_Kg.]
  1570.  
  1571. KERMIT is a file transfer protocal especially for Mainframes.  KERMIT.TTP
  1572. allows communication with this protocal.
  1573.  
  1574. TERM.TTP is a simple BTX decoder, with BTX.RUF it will start running in
  1575. the RUFUS window.
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581. - 30 -
  1582.  
  1583. APPENDIX D
  1584. Listing of RUFUS Commands
  1585.  
  1586.  
  1587. ADD var1 value1 value2
  1588. ALERT [var] form_string
  1589. BAUDRATE baud|var
  1590. BELL 0|1
  1591. CLEARBUFFER
  1592. CLR
  1593. CRLF
  1594. DIAL [var] telephone_number
  1595. DIV var value1 value2
  1596. DOWNLOAD [var] file_name
  1597. END
  1598. FDELETE [var] file_name
  1599. FILEEXIST [var] file_name
  1600. GOSUB
  1601. GOTO label
  1602. IF candition n1 n2 label
  1603. LOADINF file_name
  1604. MUL var value 1 value2
  1605. NOCRLF
  1606. PRINT string[-] | \nnn |
  1607. PROTOKOLL protocal
  1608. QUIT
  1609. RETURN
  1610. RWAIT [var] string [constant]
  1611. RUN file_name [cmdline]
  1612. RWAIT [var] string [timeout]
  1613. SAVEBUFFER file_name
  1614. SEND string[-] | \nnn |
  1615. SUB var value1 value2
  1616. SYSTEM command
  1617. TERMINAL 0|1|2|var
  1618. TIMEOUT sec
  1619. UPLOAD [var] file_name
  1620. WAIT [var] [constant]
  1621.  
  1622.  
  1623.  
  1624.  
  1625.  
  1626. - 31 -
  1627.  
  1628. INDEX
  1629.  
  1630. Accessory Mode
  1631. ANSI
  1632. Batch
  1633. BTX
  1634. Buffer
  1635. Set Font
  1636. Function Keys
  1637. GDOS
  1638. Kermit
  1639. Key Cover
  1640. Modem
  1641. Multitasking
  1642. Path
  1643. RS232
  1644. Shareware
  1645. STREAM
  1646. Terminal
  1647. VT100
  1648. VT52
  1649. XMODEM
  1650. YMODEM
  1651. YMODEM/G
  1652. ZMODEM
  1653.